使用springdoc-openapi库为Spring Boot项目自动生成OpenAPI3.0规范的接口描述文档。

• 本文参考文档

• OpenAPI 3.0规范

首先在pom.xml文件中添加springdoc-openapi的依赖：

<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-core</artifactId>
    <version>1.1.45</version>
</dependency>

添加完成后，启动Spring Boot程序，通过项目的ip、端口加上默认路径/v3/api-docs访问自动生成的OpenAPI 3.0文档：

如果想要自定义路径，可在application.properties文件中指定：

springdoc.api-docs.path=/api-docs #自定义路径为/api-docs

以上方法访问的OpenAPI文档是JSON格式，可读性非常差，可以通过访问默认路径/v3/api-docs.yaml下载yaml格式的文件（如果自定义路径，注意对路径作相应的调整）：